HTTPPollDefs


Schema to define HTTP polls for a device

Type: array
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Duration

Type: object

Schema to define a finite duration

No Additional Properties

Type: enum (of string)

Must be one of:

  • "microsecond"
  • "microseconds"
  • "micro"
  • "micros"
  • "µs"
  • "millisecond"
  • "milliseconds"
  • "milli"
  • "millis"
  • "ms"
  • "second"
  • "seconds"
  • "s"
  • "minute"
  • "minutes"
  • "m"
  • "hour"
  • "hours"
  • "h"
  • "day"
  • "days"
  • "d"

Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

Type: object
No Additional Properties

Type: string

Must be at least 1 characters long

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "http"
  • "https"

Type: integer

Value must be greater or equal to 1 and lesser or equal to 65535

Type: object

Basically the same structure for headers / query params / form data

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*

Type: array of string
No Additional Items

Each item of this array must be:

Type: array of number
No Additional Items

Each item of this array must be:

Type: array of boolean
No Additional Items

Each item of this array must be:

Type: string
Must match regular expression: ^[/].*$

Type: object

Basically the same structure for headers / query params / form data

Same definition as headers

Type: enum (of string)

Must be one of:

  • "GET"
  • "PATCH"
  • "POST"
  • "PUT"
  • "DELETE"
  • "HEAD"
  • "OPTIONS"

Duration

Type: object

Schema to define a finite duration

Same definition as pollRate

Type: object
No Additional Properties

Type: object

Basically the same structure for headers / query params / form data

Same definition as headers
Type: object
No Additional Properties

Type: object

Transform the response, ensure the transformed output matches the schema, then transform the result again to get the poll state for followup

Type: object
No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Type: object

Type: object

Type: object
No Additional Properties

Type: string

Optional, JSONPath to array if not operating on it directly


Type: object

Combine an array of objects into one object

No Additional Properties

Type: boolean

Choose to overwrite values for duplicate keys or form a list of values


Filter an array


Type: object

Reduce an array. The transform will be run on each item in the array, with the input to the transform being an object with fields acc and current. The acc field will be populated with the xform init parameter for the first element. If the output of the transform is an object with an acc field, that will be used as the newly-accumulated value, otherwise the whole output will be in the acc field on the next item.

No Additional Properties

Type: object

Convert an array of numbers to a string. Defaults to utf-8 encoding.

No Additional Properties

BinaryEncoding

Type: enum (of string)

Must be one of:

  • "base64"
  • "hex"
  • "utf8"
  • "utf16le"
  • "latin1"
Type: object

Generates checksum from input string and returns isValid boolean or checksum-inserted string

Type: object
No Additional Properties

Type: enum (of string)

Name of the algorithm (i.e. miteq, twoCharSum, mclCRC16)

Must be one of:

  • "miteq"
  • "twoCharSum"
  • "mclCRC16"

Type: string

Path to string property containing message to checksum

Type: object

Take an array of objects and a field to combine on, and output an array of objects with that field being unique among them, and other fields combined into arrays.

Type: object

Takes two arrays of objects and outputs one array with all the combinations of values of both. Transformation(s) can be provided to modify the output.

Type: object

Make a copy of a field with a new name or multiple new names

Type: object
No Additional Properties

Type: string

Copy a field from the root (ignoring operateOn) instead of using fieldName

Type: object

Keep or discard the given fields

Type: object

Insert fields into an object, or values into an array

Type: object

Takes two arrays of objects, and outputs one array of combined objects, joined by a key field.

Type: object
No Additional Properties

Type: string

JSONPath to first array. The key field in this array should have unique values for each object.

Type: string

JSONPath to second array. The non-key fields of objects in this array will be collected into arrays on the matching record from the first array.

Type: boolean

Flag to keep the non key fields as objects. If not defined will turn non key fields into arrays. If using this flag and there are multiple values for a field based on the join, the last one will be chosen

Type: object

Take an array of objects and build one object where keys and values are extracted from array rows (or the reverse)

Type: object

Type: object
No Additional Properties


Type: enum (of string)

Must be one of:

  • "ctof"
  • "ftoc"
  • "round"
  • "floor"
  • "ceil"
  • "sqrt"
  • "~"
  • "NOT"
Type: object

Move data

Type: object

Type: object

Type: object

Take a value and move it elsewhere. Tries to intelligently handle objects/arrays

No Additional Properties

Type: string

JSONPath to where value will be placed, or root if unspecified

Type: string

If target is an object and this is specified, add this field with the source value

Type: object

Takes the array of packets from a multiple-datasource field and transforms it into an object with the given field names and their payloads, optionally transformed

Type: object
No Additional Properties

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

Name in the final object which will contain the payload for this DS

Must be at least 1 characters long

Type: object

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "numberBitManipulation"


Type: object

Convert a signed integer to an unsigned integer or vice versa

No Additional Properties

Type: object

Convert a little endian integer to a bit endian integer or vice versa

No Additional Properties

Type: object

Type: object
No Additional Properties


Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision

No Additional Properties
Type: object

Type: object
No Additional Properties


Type: object

Lookup table, incoming values will be replaced with their matching entry. If regex flag is true, keys should be valid regex patterns

Type: string

JSONPath expression that resolves to an object to which the same rules apply. This expression is applied to the original value (before operateOn is taken into account).

Type: boolean

If true, replacement keys must be valid regexes, and replacement values can be strings with $1 - $99 placeholders for match groups

RegexFlags

Type: array of enum (of string)

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp

All items must be unique

No Additional Items

Each item of this array must be:

Type: object

Runs a rule with json-rules-engine and outputs based on whether the rule evaluates to true or false

Type: object
No Additional Properties

RuleXformRule

Type: object

A subset of json-rules-engine rules to be used in xforms

Type: object
No Additional Properties

Type: object

Type: object

Type: object

Type: object

Type: object

Treat two arrays as sets and perform set operations on them.

Type: object

Type: object
No Additional Properties

Type: string

Name of the shared xforms file containing the transform

Type: object

A shared xform may define variables it can take in, if it does then values need to be provided to replace them with

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .+
Type: string
Type: object

Type: object

Apply transform(s) to an snmpGet payload, looked up by OID

No Additional Properties

Type: object

OID keys

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(\d+[.])*\d+$
Type: object
No Additional Properties

Type: object

Type: object

Apply transform(s) to columns in each row of an snmpGetTable payload

No Additional Properties

Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(\d+[.])*\d+$
Type: object
No Additional Properties

Type: boolean

Set to true to output an array of objects keyed by index

Type: object

Type: object
No Additional Properties


Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimEnd

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimStart

No Additional Properties
Type: object

Convert string to array of code points

No Additional Properties
Type: object

Join different strings together

No Additional Properties
Type: object

Create an object based on regex searches through text

Type: object
No Additional Properties

Type: object

Keys are regexes to search for

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
Type: object
No Additional Properties

Type: object

Type: object

Transform with a JS Script

No Additional Properties

Type: string

Runs a basic JS Script and outputs the returned result. A const input holds the result of the previous transforms.

Must match regular expression: ^((?!(\b(eval|Function|import|export|function|fs|file|File|os|close|open|addEventListener|removeEventListener|console|location|write|body|localStorage|sessionStorage|document|window|alert))[; .({]).)*$

Core schema meta-schema

Type: object or boolean Default: true

Type: number

Value must be strictly greater than 0

Type: integer

Value must be greater or equal to 0

Type: array of string Default: []

All items must be unique

No Additional Items

Each item of this array must be:

Type: object Default: {}

Each additional property must conform to the following schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Type: object Default: {}

Each additional property must conform to the following schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Type: object Default: {}

Each additional property must conform to the following schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Type: array

Must contain a minimum of 1 items

All items must be unique

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck
Type: object
No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform

Type: object

Run this request with the poll state from the initial stage until a success or failure result

Type: object
No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform

Core schema meta-schema

Type: object or boolean Default: true

Type: number

Value must be strictly greater than 0

Type: integer

Value must be greater or equal to 0

Type: array of string Default: []

All items must be unique

No Additional Items

Each item of this array must be:

Type: object Default: {}

Each additional property must conform to the following schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Type: object Default: {}

Each additional property must conform to the following schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Type: object Default: {}

Each additional property must conform to the following schema

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Type: array

Must contain a minimum of 1 items

All items must be unique

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck

Core schema meta-schema

Type: object or boolean Default: true
Same definition as successCheck
Type: object
No Additional Properties

Type: object

TransientTokenHandling

Type: object

Describes how to configure devices that need to fetch an auth token

No Additional Properties

Type: object

Type: object

Type: object

If username/password credentials are associated with this data collection, the given request object will have '${username}' and '${password}' replaced before sending.

No Additional Properties
Type: object

Simple json path to extract token from response

No Additional Properties

Type: string

Json Path to retrieve the token from the Rest response, which will be an HttpPayload

Type: object

Type: object

If username/password credentials are associated with this data collection, the given request object will have '${username}' and '${password}' replaced before sending.

Same definition as oneOf_i1_transientToken_allOf_i0_creation_oneOf_i0_allOf_i0
Type: object

Run a transform on response to get token; transform result must be a string

No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform
Type: object

Tell the system when a poll return signifies an auth failure, so the token should be refreshed. The received HttpPayload will be sent into the transform, and if the transformed output is equal to authFailedOutput then token refresh is required. Example: the status field of the payload could be extracted in xform and authFailedOutput be set to the value 403, if the server sends a forbidden response for an expired token.

No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as successCheckTransform